Skip to content

fix: 📝 Add missing docs to .respond methods #3061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
ToothyDev wants to merge 16 commits into
base: master
Choose a base branch
from
Open

fix: 📝 Add missing docs to .respond methods #3061

ToothyDev wants to merge 16 commits into from
+116 −16

Conversation

@ToothyDev
Copy link
Contributor

@ToothyDev ToothyDev commented Jan 9, 2026

Summary

Previously, the possible parameters for both Interaction.respond and ApplicationContext.respond (which copied its docs) weren't documented, this is now the case

Information

  • This PR fixes an issue.
  • This PR adds something new (e.g. new method or parameters).
  • This PR is a breaking change (e.g. methods or parameters removed/renamed).
  • This PR is not a code change (e.g. documentation, README, typehinting,
    examples, ...).

Checklist

  • I have searched the open pull requests for duplicates.
  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • If type: ignore comments were used, a comment is also left explaining why.
  • I have updated the changelog to include these changes.

@ToothyDev ToothyDev requested review from a team as code owners January 9, 2026 17:51
@pycord-app
Copy link

pycord-app bot commented Jan 9, 2026

Thanks for opening this pull request!
Please make sure you have read the Contributing Guidelines and Code of Conduct.

This pull request can be checked-out with:

git fetch origin pull/3061/head:pr-3061
git checkout pr-3061

This pull request can be installed with:

pip install git+https://github.com/Pycord-Development/pycord@refs/pull/3061/head

@ToothyDev ToothyDev changed the title fix:📝 Add missing docs to .respond methods fix: 📝 Add missing docs to .respond methods Jan 9, 2026
@ToothyDev ToothyDev changed the title fix: 📝 Add missing docs to .respond methods fix: 📝 Add missing docs to .respond methods Jan 9, 2026
@ToothyDev
Copy link
Contributor Author

ToothyDev commented Jan 9, 2026

In case I forgot any, please tell me

@ToothyDev
Copy link
Contributor Author

ToothyDev commented Jan 9, 2026

DA344 said I could also flesh out the method signatures of both methods to actually list and typehint the possible (kw)args for both functions, so, if you want that, just say so.

@Dorukyum
Copy link
Member

Dorukyum commented Jan 10, 2026

I think it'd be better if the arguments were explicitly type hinted.

@Lulalaby
Copy link
Member

Lulalaby commented Jan 10, 2026

I agree with doru

@ToothyDev
Copy link
Contributor Author

ToothyDev commented Jan 10, 2026 •
edited
Loading

This removes the @property decorator from ApplicationContext.respond and makes the function async instead, because otherwise I can't properly overload it. In my testing, this was in no way breaking, and I already brought up in Discord how that decorator seems unnecessary for that method, but let me know what you think

@Paillat-dev Paillat-dev added documentation Improvements or additions to documentation priority: low Low Priority labels Jan 10, 2026
@Paillat-dev Paillat-dev added this to the v2.7.1 milestone Jan 10, 2026
@Paillat-dev Paillat-dev added the typing Is related to / changes python typing label Jan 10, 2026
@Paillat-dev Paillat-dev marked this pull request as draft January 10, 2026 14:08
Paillat-dev
Paillat-dev requested changes Jan 11, 2026
View reviewed changes
@ToothyDev ToothyDev requested a review from Paillat-dev January 11, 2026 16:29
Dorukyum
Dorukyum requested changes Jan 11, 2026
View reviewed changes
@Paillat-dev Paillat-dev modified the milestones: v2.7.1, v2.8 Jan 11, 2026
JustaSqu1d
JustaSqu1d requested changes Jan 13, 2026
View reviewed changes
@ToothyDev ToothyDev mentioned this pull request Jan 13, 2026
Draft
9 tasks
@ToothyDev
Copy link
Contributor Author

ToothyDev commented Jan 13, 2026

I'd prefer this to be in 2.7.1 instead of 2.8 as in it's current form, it only really consists of adding missing documentation, even though that had to involve a minor code change (which doesn't cause any user code to break)

@Paillat-dev Paillat-dev modified the milestones: v2.8, v2.7.1 Jan 13, 2026
Dorukyum
Dorukyum requested changes Jan 14, 2026
View reviewed changes
@ToothyDev ToothyDev requested a review from Dorukyum January 14, 2026 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@NeloBlivion NeloBlivion Awaiting requested review from NeloBlivion NeloBlivion is a code owner automatically assigned from Pycord-Development/library-maintainers

@EmmmaTech EmmmaTech Awaiting requested review from EmmmaTech EmmmaTech is a code owner automatically assigned from Pycord-Development/library-contributors

@DA-344 DA-344 Awaiting requested review from DA-344 DA-344 is a code owner automatically assigned from Pycord-Development/library-contributors

@Paillat-dev Paillat-dev Awaiting requested review from Paillat-dev

@JustaSqu1d JustaSqu1d Awaiting requested review from JustaSqu1d

@Dorukyum Dorukyum Awaiting requested review from Dorukyum

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation PA: All Contributors pending PA: Maintainers pending priority: low Low Priority typing Is related to / changes python typing

Projects

None yet

Milestone

v2.7.1

Development

Successfully merging this pull request may close these issues.

6 participants

@ToothyDev @Dorukyum @Lulalaby @Paillat-dev @JustaSqu1d @DA-344